home *** CD-ROM | disk | FTP | other *** search
/ Aminet 24 / Aminet 24 (1998)(GTI - Schatztruhe)[!][Apr 1998].iso / Aminet / dev / c / cxref_1_4a.lha / AMIGA.readme < prev    next >
Text File  |  1998-02-17  |  3KB  |  77 lines
  1. About cxref
  2. ===========
  3. Wait a minute. This is not the standard simplistic `C' source code
  4. cross reference tool you are probably already familiar with. Quite
  5. on the contrary, Andrew M. Bishop's `cxref' program is among the
  6. most powerful and useful tools I have ever found. Not only does it
  7. perform the usual cross-referencing, it also takes note of where
  8. each global or local variable is used, which routine calls what
  9. other routines and what routines and variables are not used at all.
  10. Very useful if you are cleaning up older code or source code you
  11. have taken over from someone else. Another neat feature of the
  12. cxref program is that you can actually embed documentation in your
  13. programs and have cxref extract and pretty print it, yielding
  14. LaTeX or even html output.
  15.  
  16. Requirements
  17. ============
  18. You need Kickstart 2.04 or higher and it definitely helps to have
  19. lots of memory installed in your machine. Scanning and analysis of
  20. the source code is performed by the modified GNU `C' preprocessor.
  21. Its output is piped through to the cxref program, which is why you
  22. need to have a working pipe-handler installed. Heinz Wrobel's pipe
  23. handler, as found on Aminet, will do nicely.
  24.  
  25. Installation
  26. ============
  27. There are three programs which you will want to install. Just copy
  28. them from the "bin" drawer to whereever you keep your development
  29. tools. Make sure that all tools are in the shell search path,
  30. otherwise the cxref program will have trouble launching the cxref-cpp
  31. program.
  32.  
  33. Invocation
  34. ==========
  35. Simple. While this is described in the cxref documentation, it's still
  36. a good idea to mention that the cross-referencing is actually a two-step
  37. process. You have to build the initial database before you can create
  38. the index and the html files. Thus, in order to create a browsable
  39. cross-reference, you should enter the following:
  40.  
  41.    cxref -xref #?.c
  42.    cxref -xref -index -html #?.c
  43.  
  44. Later, if you make changes to the source code, just use the second
  45. command again:
  46.  
  47.    cxref -xref -index -html #?.c
  48.  
  49. This will automatically update all the cross reference information.
  50. As you can see, the cxref Amiga port will expand all wildcard
  51. patterns given on the command line.
  52.  
  53. About the Amiga port
  54. ====================
  55. This port is functionally almost identical to the regular 1.4a with
  56. a bug fixed in the scanner that collects documentation comments.
  57. This bug fix was sent to me by Andrew M. Bishop, so I expect that
  58. it will also show up in the regular release any time now.
  59.  
  60. The code uses quite a number of Unix'isms, such as in the file path
  61. parsing or piping the output of a child process into the scanner.
  62. In order to allow for the program to work on the Amiga I made small
  63. modifications to the code and even the flex and bison source code
  64. generated for the preprocessor and the main program.
  65.  
  66. While I hope that the resulting program works as it should, one
  67. can never be certain. If you find bugs or other nuisances, feel
  68. free to contact me:
  69.  
  70.    Olaf Barthel
  71.    Brabeckstrasse 35
  72.    D-30559 Hannover
  73.  
  74.    Federal Republic of Germany
  75.  
  76.    <olsen@sourcery.han.de>
  77.